Loading...
Searching...
No Matches
rapidjson::GenericSchemaDocument< ValueT, Allocator > Class Template Reference

JSON schema document. More...

#include <schema.h>

Public Types

typedef ValueT ValueType
typedef IGenericRemoteSchemaDocumentProvider< GenericSchemaDocumentIRemoteSchemaDocumentProviderType
typedef Allocator AllocatorType
typedef ValueType::EncodingType EncodingType
typedef EncodingType::Ch Ch
typedef internal::Schema< GenericSchemaDocumentSchemaType
typedef GenericPointer< ValueType, AllocatorPointerType
typedef GenericValue< EncodingType, AllocatorTypeGValue
typedef GenericUri< ValueType, AllocatorUriType
typedef GenericStringRef< Ch > StringRefType

Public Member Functions

 GenericSchemaDocument (const ValueType &document, const Ch *uri=0, SizeType uriLength=0, IRemoteSchemaDocumentProviderType *remoteProvider=0, Allocator *allocator=0, const PointerType &pointer=PointerType(), const Specification &spec=Specification(kDraft04))
 Constructor.
 ~GenericSchemaDocument ()
 Destructor.
const GValueGetURI () const
const SpecificationGetSpecification () const
bool IsSupportedSpecification () const
const SchemaType & GetRoot () const
 Get the root schema.
GValueGetError ()
 Gets the error object.
const GValueGetError () const
void SchemaError (const SchemaErrorCode code, const PointerType &location)
 Default error method.
void SchemaErrorValue (const SchemaErrorCode code, const PointerType &location, const Ch *value, SizeType length)
 Method for error with single string value insert.
void SchemaErrorPointer (const SchemaErrorCode code, const PointerType &location, const Ch *value, SizeType length, const PointerType &pointer)
 Method for error with invalid pointer.

Static Public Member Functions

static const Specification GetSpecification (const ValueType &document)
 Static method to get the specification of any schema document.
static const StringRefTypeGetSchemaErrorKeyword (SchemaErrorCode schemaErrorCode)

Friends

template<typename, typename, typename>
class GenericSchemaValidator

Detailed Description

template<typename ValueT, typename Allocator = CrtAllocator>
class rapidjson::GenericSchemaDocument< ValueT, Allocator >

JSON schema document.

A JSON schema document is a compiled version of a JSON schema. It is basically a tree of internal::Schema.

Note
This is an immutable class (i.e. its instance cannot be modified after construction).
Template Parameters
ValueTType of JSON value (e.g. Value ), which also determine the encoding.
AllocatorAllocator type for allocating memory of this document.

Constructor & Destructor Documentation

◆ GenericSchemaDocument()

template<typename ValueT, typename Allocator = CrtAllocator>
rapidjson::GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument ( const ValueType & document,
const Ch * uri = 0,
SizeType uriLength = 0,
IRemoteSchemaDocumentProviderType * remoteProvider = 0,
Allocator * allocator = 0,
const PointerType & pointer = PointerType(),
const Specification & spec = Specification(kDraft04) )
inlineexplicit

Constructor.

Compile a JSON document into schema document.

Parameters
documentA JSON document as source.
uriThe base URI of this schema document for purposes of violation reporting.
uriLengthLength of name, in code points.
remoteProviderAn optional remote schema document provider for resolving remote reference. Can be null.
allocatorAn optional allocator instance for allocating memory. Can be null.
pointerAn optional JSON pointer to the start of the schema document
specOptional schema draft or OpenAPI version. Used if no specification in document. Defaults to draft-04.

The documentation for this class was generated from the following files: